Skip to main content

How To Upgrade To A New Version Of The Java RESTful Engine

This article outlines the steps you should take when upgrading your Java RESTful Engine to a new version when its availible. Check the Downloads Page for the most recent version.

Requirments​

All you need to upgrade the Java RESTful Engine to a newer version is the new ROOT.war file for the new version.

Steps​

  1. Ensure that the RESTful Engine is not running (run the shutdown.sh file in the bin folder)
  2. Delete the RESTful file in Tomcat/webapps (delete the ROOT directory and the ROOT.war file)
    note

    If you have any special configurations in your WindwardReports.properties file and don't want to go through setting it up again, we recommend you move the WindwardReports.properties file from the RESTful directory before deleting it, and placing it in the new RESTful directory when its setup.

  3. After deleting the previous ROOT file and directory, paste the new one in the Tomcat/webapps directory
  4. To extract the WAR start the RESTful engine by running the startup.sh file in the Tomcat/bin directory.
  5. Navigate to /opt/apache-tomcat-10.x.x/webapps/ROOT/WEB-INF/classes/. Make sure you have the license key set in the WindwardReports.properties
  6. Shutdown the engine by running the shutdow.sh file in the Tomcat/bin, then start it up again by running the startup.sh
  7. Your new Java RESTful engine is now setup and ready to use.